/******************************************************************************
    myBoard is a port of MacOS X dashboard application for windows.
    Copyright (C) 2007,2008  by Yann ALET
    Email : yann.alet@gmail.com

    myBoard is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    myBoard is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
****************************************************************************/

using System;
using System.Collections.Generic;
using System.Text;
using System.Windows;
using System.Windows.Media.Imaging;
using System.Windows.Controls;
using System.Reflection;

namespace myBoard.Framework
{
    public interface IMagnet
    {
        #region Properties 

        /// <summary>
        /// This the magnet name used in the magnets library explorer
        /// </summary>
        string MagnetName { get;}

        /// <summary>
        /// This is your magnet ID in the Magnets Store. Each magnet must have a unique StoreID.
        /// </summary>
        string StoreID { get;}

        /// <summary>
        /// This is the image myBoard will use to show your magnet in the magnets explorer.
        /// </summary>
        BitmapImage Icon { get; }

        /// <summary>
        /// This is the image the Icon will morph into when you drag your magnet out of the magnets explorer
        /// </summary>
        BitmapImage Thumbnail { get;}

        #endregion

        #region Methods

        /// <summary>
        /// myBoard will call this method when the user close your magnet.
        /// You should free all resources when this method is called
        /// </summary>
        void Terminate();        

        #endregion
    }
}
